<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Derived Data Set Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">DerivedDataSet Element</p>
<h1>Element Overview</h1>
<div class="section-text">
An extended data set retrieved by a query through an extension driver and contains sub data set contents.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Derived Data Set</td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>XML Element:</td>
<td><code>derived-data-set</code></td></tr>
<tr><td>Extends:</td>
<td><a href="SimpleDataSet.html">SimpleDataSet</a></td></tr>
<tr><td>Extendable:</td>
<td>Yes</td></tr>
<tr><td>Abstract:</td>
<td>No</td></tr>
<tr><td>Name Space:</td>
<td>Data Sets</td></tr>
<tr><td>Name Requirement:</td>
<td>Required</td></tr>
<tr><td>Allows User Properties:</td>
<td>Yes</td></tr>
<tr><td>Has Style:</td>
<td>No</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-extensionID">extensionID</a></dt>
<dd>The ID of a data set type supported by the ODA data source extension.</dd>
<dt><a href="#Property-inputDataSets">inputDataSets</a></dt>
<dd>The sub data set elements that the query text refer.</dd>
<dt><a href="#Property-queryText">queryText</a></dt>
<dd>The static query text to execute.</dd>
</dl>

<h3>Inherited Properties</h3>

<p class="section-text">
<a href="DataSet.html#Property-cachedMetaData">cachedMetaData</a>, 
<a href="DataSet.html#Property-columnHints">columnHints</a>, 
<a href="ReportElement.html#Property-comments">comments</a>, 
<a href="DataSet.html#Property-computedColumns">computedColumns</a>, 
<a href="DesignElement.html#Property-customXml">customXml</a>, 
<a href="SimpleDataSet.html#Property-dataSetRowLimit">dataSetRowLimit</a>, 
<a href="ReportElement.html#Property-displayName">displayName</a>, 
<a href="ReportElement.html#Property-displayNameID">displayNameID</a>, 
<a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>, 
<a href="ReportElement.html#Property-extends">extends</a>, 
<a href="DataSet.html#Property-filter">filter</a>, 
<a href="ReportElement.html#Property-name">name</a>, 
<a href="DataSet.html#Property-needsCache">needsCache</a>, 
<a href="ReportElement.html#Property-newHandlerOnEachEvent">newHandlerOnEachEvent</a>, 
<a href="SimpleDataSet.html#Property-paramBindings">paramBindings</a>, 
<a href="DataSet.html#Property-parameters">parameters</a>, 
<a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, 
<a href="SimpleDataSet.html#Property-refTemplateParameter">refTemplateParameter</a>, 
<a href="DataSet.html#Property-resultSetHints">resultSetHints</a>, 
<a href="DataSet.html#Property-rowFetchLimit">rowFetchLimit</a>, 
<a href="DataSet.html#Property-sortHints">sortHints</a>, 
<a href="DesignElement.html#Property-userProperties">userProperties</a>, 
<a href="ReportElement.html#Property-viewAction">viewAction</a>
</p>
<h3>Inherited Methods</h3>

<p class="section-text">
<a href="SimpleDataSet.html#Method-beforeOpen">beforeOpen</a>, 
<a href="SimpleDataSet.html#Method-beforeClose">beforeClose</a>, 
<a href="SimpleDataSet.html#Method-onFetch">onFetch</a>, 
<a href="SimpleDataSet.html#Method-afterOpen">afterOpen</a>, 
<a href="SimpleDataSet.html#Method-afterClose">afterClose</a></p>
<h3>Description</h3>

<div class="section-text">
<p>The Derived Data Set represents an extended data set that defines query text which is managed
by an extension driver.</p>

<p>The Derived Data Set element defines a series of sub data set elements that are referred in their query
text. The item in the list can be any type of data set Model supports, such as script data set, ODA data set, 
joint data set and another derived data set.</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-extensionID">extensionID Property</a></h2>

<p class="section-text">The ID of a data set type supported by the ODA data source extension.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Extension ID</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The fully qualified ID that uniquely identifies the type
of ODA data set definition in the BIRT environment.  It is defined in the ODA data
source extension plug-in manifest (plugin.xml) in the <code>dataSet.id</code>
attribute. Its value is optional
if the ODA extension supports only one type of data set.</p></div>

<hr>
<h2><a name="Property-inputDataSets">inputDataSets Property</a></h2>

<p class="section-text">The sub data set elements that the query text refer.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#list">list</a></td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Input data sets</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>List of the name of the sub data sets that this element refers.</p></div>

<hr>
<h2><a name="Property-queryText">queryText Property</a></h2>

<p class="section-text">The static query text to execute.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#xml">xml</a></td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Query</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The query text used in opening a data set. Specific ODA driver defines the
format of this string. The query text is passed through to the ODA run-time
driver to prepare a query for execution.</p></div>
</body>
</html>
